<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Framework Extras API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/jquery-ui.css" type="text/css"></link><link rel="stylesheet" href="css/docblox/jquery-ui-1.8.16.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
            $(document).ready(function() {
                $(".filetree").treeview({
                    collapsed: true,
                    persist: "cookie"
                });

                $("#accordion").accordion({
                    collapsible: true,
                    autoHeight:  false,
                    fillSpace:   true
                });

                $(".tabs").tabs();
            });
        </script></head><body><div xmlns="" class="content">
<div class="sub-page-main-header-api-documentation"><h2>API Documentation</h2></div>
<div class="dotted-line"></div>
</div>
<div xmlns="" id="content">
<script xmlns:dbx="http://docblox-project.org/xsl/functions">

      function filterElements()
      {
        inherited = !$('#show-inherited').hasClass('deselected');
        public    = !$('#show-public').hasClass('deselected');
        protected = !$('#show-protected').hasClass('deselected');
        private   = !$('#show-private').hasClass('deselected');

        $('div.public').each(function(index, val) {
            $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.protected').each(function(index, val) {
            $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.private').each(function(index, val) {
            $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
        });
      }

      $(document).ready(function() {
        $('a.gripper').click(function() {
            $(this).nextAll('div.code-tabs').slideToggle();
            $(this).children('img').toggle();
            return false;
        });

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
            $(this).parent().nextAll('div.code-tabs').slideToggle();
            $(this).parent().prevAll('a.gripper').children('img').toggle();
            return false;
        });

        $('div.code-tabs').hide();
        $('a.gripper').show();
        $('div.code-tabs:empty').prevAll('a.gripper').html('');

        $('#show-public, #show-protected, #show-private, #show-inherited')
            .css('cursor', 'pointer')
            .click(function(){
                $(this).toggleClass('deselected');
                if ($(this).hasClass('deselected')) {
                  $(this).fadeTo('fast', '0.4');
                } else {
                  $(this).fadeTo('fast', '1.0');
                }
                filterElements();
                return false;
            });
        $('#show-protected, #show-private').click();

        // add the sliding behaviour to the file navigation and show it
        // it is initially hidden for non-JS users.
        $("#file-nav-box").show().hover(function() {
            $("#file-nav-container").slideDown(400);
        }, function() {
            $("#file-nav-container").slideUp(400);
        });
      });

      
    </script><h1 xmlns:dbx="http://docblox-project.org/xsl/functions" class="file">ZendX/JQuery.php</h1>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" id="file-nav-box">
<div id="file-nav-options">
              Show:
              <img src="images/icons/visibility_public.png" id="show-public"><img src="images/icons/visibility_protected.png" id="show-protected"><img src="images/icons/visibility_private.png" id="show-private"><span class="attribute" id="show-inherited">inherited</span>
</div>
<div id="file-nav-container">
<ul id="file-nav"><li>
<a href="#classes"><img src="images/icons/class.png" height="14">
                          Classes
                      </a><ul><li><a href="#%5CZendX_JQuery">\ZendX_JQuery</a></li></ul>
</li></ul>
<div style="clear: left;"></div>
</div>
<div id="file-nav-tab">
              Table of Contents
          </div>
</div>
<a xmlns:dbx="http://docblox-project.org/xsl/functions" name="top" class="anchor"></a><div id="file-description">
<p xmlns:dbx="http://docblox-project.org/xsl/functions" class="short-description">Zend Framework</p>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="long-description"><p>LICENSE</p>

<p>This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.</p>
</div>
</div>
<dl class="file-info">
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Category</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">ZendX
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Copyright</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">License</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">
<a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Package</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">ZendX_JQuery
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Subpackage</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">View
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Version</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">$Id: JQuery.php 21867 2010-04-16 07:45:34Z beberlei $
         
    </dd>
</dl>
<a name="classes" class="anchor"></a><a xmlns:dbx="http://docblox-project.org/xsl/functions" id="\ZendX_JQuery" class="anchor"></a><h2 xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">\ZendX_JQuery<div class="to-top"><a href="#top">jump to top</a></div>
</h2>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">
<small class="package"><b>Package: </b>ZendX\JQuery</small><p class="short-description">jQuery Global Class holding constants and static convienience methods.</p>
<div class="long-description">
</div>
<dl class="class-info">
<dt>Copyright</dt>
<dd>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
         
    </dd>
<dt>License</dt>
<dd>
<a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
         
    </dd>
<dt>Todo</dt>
<dd>Offer convenience methods to add a tab or accordion container/pane combination.
         
    </dd>
</dl>
<h3>Constants</h3>
<div>
<a id="\ZendX_JQuery::DEFAULT_JQUERY_VERSION" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">DEFAULT_JQUERY_VERSION</span>
                = "1.3.2"</code><div class="description"><p class="short-description">Current default supported jQuery library version with ZendX_JQuery</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>string
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::DEFAULT_UI_VERSION" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">DEFAULT_UI_VERSION</span>
                = "1.7.1"</code><div class="description"><p class="short-description">Currently supported jQuery UI library version with ZendX_JQuery</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>string
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::CDN_BASE_GOOGLE" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">CDN_BASE_GOOGLE</span>
                = 'http://ajax.googleapis.com/ajax/libs/'</code><div class="description"><p class="short-description"></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>string Base path to CDN
         
    </dd>
<dt>See</dt>
<dd>\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::CDN_BASE_GOOGLE_SSL" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">CDN_BASE_GOOGLE_SSL</span>
                = 'https://ajax.googleapis.com/ajax/libs/'</code><div class="description"><p class="short-description"></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>string Base path to CDN
         
    </dd>
<dt>See</dt>
<dd>\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::CDN_SUBFOLDER_JQUERY" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">CDN_SUBFOLDER_JQUERY</span>
                = 'jquery/'</code><div class="description"><p class="short-description"></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>string
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::CDN_SUBFOLDER_JQUERYUI" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">CDN_SUBFOLDER_JQUERYUI</span>
                = 'jqueryui/'</code><div class="description"><p class="short-description"></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>string
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::CDN_JQUERY_PATH_GOOGLE" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">CDN_JQUERY_PATH_GOOGLE</span>
                = '/jquery.min.js'</code><div class="description"><p class="short-description">Always uses compressed version, because this is assumed to be the use case
in production enviroment. An uncompressed version has to included manually.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>string File path after base and version
         
    </dd>
<dt>See</dt>
<dd>\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::RENDER_LIBRARY" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">RENDER_LIBRARY</span>
                = 1</code><div class="description"><p class="short-description">Which parts of the the jQuery library should be rendered on echo'ing
the jQuery library to the View. The constants act as bit-mask. This
way the jQuery autogenerated code can be refactored based on personal needs.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<dl class="constant-info">
<dt>Const</dt>
<dd>Integer
         
    </dd>
<dt>See</dt>
<dd>\ZendX_JQuery_Helper_JQuery::setRenderMode
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::RENDER_SOURCES" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">RENDER_SOURCES</span>
                = 2</code><div class="description"></div>
<div class="code-tabs"><dl class="constant-info"></dl></div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::RENDER_STYLESHEETS" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">RENDER_STYLESHEETS</span>
                = 4</code><div class="description"></div>
<div class="code-tabs"><dl class="constant-info"></dl></div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::RENDER_JAVASCRIPT" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">RENDER_JAVASCRIPT</span>
                = 8</code><div class="description"></div>
<div class="code-tabs"><dl class="constant-info"></dl></div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::RENDER_JQUERY_ON_LOAD" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">RENDER_JQUERY_ON_LOAD</span>
                = 16</code><div class="description"></div>
<div class="code-tabs"><dl class="constant-info"></dl></div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::RENDER_ALL" class="anchor"></a><div class="constant publicC">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/constant.png" alt="Constant"> 
                <span class="highlight">RENDER_ALL</span>
                = 255</code><div class="description"></div>
<div class="code-tabs"><dl class="constant-info"></dl></div>
<div class="clear"></div>
</div>
</div>
<h3>Methods</h3>
<div>
<a id="\ZendX_JQuery::enableForm()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">enableForm</span><span class="nb-faded-text">(
          \Zend_Form $form
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">static</span><p class="short_description">jQuery-enable a form instance</p>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$form</th>
<td>\Zend_Form</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::enableView()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">enableView</span><span class="nb-faded-text">(
          \Zend_View_Interface $view
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">static</span><p class="short_description">jQuery-enable a view instance</p>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$view</th>
<td>\Zend_View_Interface</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery::encodeJson()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">encodeJson</span><span class="nb-faded-text">(
          mixed $value
          )
        </span>
        :
          mixed</code><div class="description">
<span class="attribute">static</span><p class="short_description">Encode Json that may include javascript expressions.</p>
</div>
<div class="code-tabs">
<div class="long-description"><p>Take care of using the Zend_Json_Encoder to alleviate problems with the json_encode
magic key mechanism as of now.</p>
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$value</th>
<td>mixed</td>
<td><em></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>mixed</td>
<td></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>See</dt>
<dd>\Zend_Json::encode
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.15.1</a>.
    </small></body></html>
